home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / il / ilFileImg.z / ilFileImg
Encoding:
Text File  |  2002-10-03  |  31.4 KB  |  661 lines

  1.  
  2.  
  3.  
  4. iiiillllFFFFiiiilllleeeeIIIImmmmgggg((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllFFFFiiiilllleeeeIIIImmmmgggg((((3333))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      iiiillllFFFFiiiilllleeeeIIIImmmmgggg - image file access
  10.  
  11. IIIINNNNHHHHEEEERRRRIIIITTTTSSSS FFFFRRRROOOOMMMM
  12.      ilLink : ilImage : ilCacheImg : ilMemCacheImg
  13.  
  14. HHHHEEEEAAAADDDDEEEERRRR FFFFIIIILLLLEEEE
  15.      #include <il/ilFileImg.h>
  16.  
  17.  
  18. CCCCLLLLAAAASSSSSSSS DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.      This class is used to access the various file formats supported by IL.
  20.      It provides functions for common operations on files.  This is a wrapper
  21.      around the underlying file format support provided by the IFL layer.
  22.  
  23.      _i_l_F_i_l_e_I_m_g also supports the ability to store multiple images in a single
  24.      file.  ggggeeeettttCCCCuuuurrrrrrrreeeennnnttttIIIImmmmgggg(((()))), sssseeeettttCCCCuuuurrrrrrrreeeennnnttttIIIImmmmgggg(((()))) and aaaappppppppeeeennnnddddIIIImmmmgggg(((()))) are functions
  25.      provided to move between images within a file.
  26.  
  27. CCCCLLLLAAAASSSSSSSS MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN SSSSUUUUMMMMMMMMAAAARRRRYYYY
  28.      CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrrssss
  29.  
  30.           ilFileImg()
  31.           ilFileImg(const char* filename, int mode=O_RDONLY,
  32.                     iflFormat* format=NULL)
  33.           ilFileImg(int fd, const char* filename, int mode=O_RDONLY,
  34.                     iflFormat* format=NULL)
  35.           ilFileImg(iflFileDesc& desc, int mode=O_RDONLY)
  36.           ilFileImg(const char* filename, ilImage* source,
  37.                     iflFileConfig* cfg=NULL, iflFormat* format=NULL)
  38.           ilFileImg(int fd, const char* filename, ilImage* source,
  39.                     iflFileConfig* cfg=NULL, iflFormat* format=NULL)
  40.           ilFileImg(iflFileDesc& desc, ilImage* source, iflFileConfig* cfg=NULL)
  41.  
  42.      OOOOppppeeeennnniiiinnnngggg,,,, ccccrrrreeeeaaaattttiiiinnnngggg aaaannnndddd cccclllloooossssiiiinnnngggg
  43.  
  44.           ilStatus openFile(const char* filename, int mode=O_RDONLY,
  45.                             iflFormat* format=NULL)
  46.           ilStatus openFile(int fd, const char* filename, int mode=O_RDONLY,
  47.                             iflFormat* format=NULL)
  48.           ilStatus openFile(iflFileDesc& desc, int mode=O_RDONLY)
  49.           ilStatus createFile(const char* filename, ilImage* source,
  50.                               iflFileConfig* cfg=NULL, iflFormat* format=NULL)
  51.           ilStatus createFile(int fd, const char* filename, ilImage* source,
  52.                               iflFileConfig* cfg=NULL, iflFormat* format=NULL)
  53.           ilStatus createFile(iflFileDesc& desc, ilImage* source,
  54.                               iflFileConfig* cfg=NULL)
  55.           ilStatus closeFile()
  56.  
  57.      QQQQuuuueeeerrrryyyyiiiinnnngggg aaaabbbboooouuuutttt ffffiiiilllleeee aaaattttttttrrrriiiibbbbuuuutttteeeessss
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. iiiillllFFFFiiiilllleeeeIIIImmmmgggg((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllFFFFiiiilllleeeeIIIImmmmgggg((((3333))))
  71.  
  72.  
  73.  
  74.           int getFileDesc()
  75.           int getFileMode()
  76.           const char* getFileName()
  77.           iflFormat* getImageFormat()
  78.           const char* getImageFormatName()
  79.           int getNumImgs()
  80.  
  81.      MMMMuuuullllttttiiiipppplllleeee IIIImmmmaaaaggggeeee SSSSuuuuppppppppoooorrrrtttt
  82.  
  83.           int getCurrentImg()
  84.           ilStatus setCurrentImg(int idx)
  85.           ilStatus appendImg(ilImage* source, iflFileConfig* cfg=NULL)
  86.           iflFile* getFileHandle()
  87.  
  88.      FFFFoooorrrrmmmmaaaatttt ssssppppeeeecccciiiiffffiiiicccc ssssuuuuppppppppoooorrrrtttt
  89.  
  90.           ilStatus getItem(int tag, va_list ap)
  91.           ilStatus setItem(int tag, va_list ap)
  92.           ilStatus getItem(int tag, ...)
  93.           ilStatus setItem(int tag, ...)
  94.  
  95.  
  96.    IIIICCCCCCCC pppprrrrooooffffiiiilllleeee aaaacccccccceeeessssssss
  97.           ilStatus getICCProfile(int& size, void*& profile)
  98.           ilStatus freeICCProfile(void* profile)
  99.           ilStatus setICCProfile(int size, const void* profile)
  100.  
  101.  
  102.  
  103. FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNN DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNNSSSS
  104.      iiiillllFFFFiiiilllleeeeIIIImmmmgggg(((())))
  105.  
  106.           ilFileImg()
  107.           ilFileImg(const char* filename, int mode=O_RDONLY,
  108.                     iflFormat* format=NULL)
  109.           ilFileImg(int fd, const char* filename, int mode=O_RDONLY,
  110.                     iflFormat* format=NULL)
  111.           ilFileImg(iflFileDesc& desc, int mode=O_RDONLY)
  112.           ilFileImg(const char* filename, ilImage* source,
  113.                     iflFileConfig* cfg=NULL, iflFormat* format=NULL)
  114.           ilFileImg(int fd, const char* filename, ilImage* source,
  115.                     iflFileConfig* cfg=NULL, iflFormat* format=NULL)
  116.           ilFileImg(iflFileDesc& desc, ilImage* source, iflFileConfig* cfg=NULL)
  117.  
  118.  
  119.           The first version of the constructor is used to construct a place
  120.           holder image with no associated file (use ooooppppeeeennnnFFFFiiiilllleeee() or ccccrrrreeeeaaaatttteeeeFFFFiiiilllleeee()
  121.           to assocate a file later).  The next three versions of the
  122.           constructor are used to open an existing image file; the last three
  123.           are used to create a new image file.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. iiiillllFFFFiiiilllleeeeIIIImmmmgggg((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllFFFFiiiilllleeeeIIIImmmmgggg((((3333))))
  137.  
  138.  
  139.  
  140.           The file is specified via the _f_i_l_e_n_a_m_e and _f_d arguments.  At least
  141.           one of these two arguments must be specified; they are interpreted
  142.           as follows.
  143.  
  144.               if filename != NULL and fd == -1:
  145.                   opens the file with the given filename.
  146.               if filename == NULL and fd != -1:
  147.                   uses the existing open file descriptor.
  148.               if filename != NULL and fd != -1:
  149.                   uses the existing open file descriptor; the filename is
  150.                   stored solely for the ggggeeeettttFFFFiiiilllleeeeNNNNaaaammmmeeee() method and error messages.
  151.  
  152.           On open operations the file name may be followed by an optional
  153.           sub-image index using the syntax "filename:index" (see
  154.           sssseeeettttCCCCuuuurrrrrrrreeeennnnttttIIIImmmmaaaaggggeeee() for how to change the sub-image index after the
  155.           file is opened).
  156.  
  157.           On open operations the mode argument specifies the desired access
  158.           mode; it should be either _O__R_D_O_N_L_Y or _O__R_D_W_R.
  159.  
  160.           The _f_o_r_m_a_t argument specifies the desired file format.  The usual
  161.           usage is to use NULL in which case the file format is deduced by the
  162.           file typing rules using the file's contents ("magic number"); this
  163.           mechanism can be bypassed by specifying the format explicitly.  When
  164.           creating a file, the format is chosen by using the filename's
  165.           extension.  If no match is found, the format
  166.           iiiiffffllllFFFFoooorrrrmmmmaaaatttt::::::::ffffiiiinnnnddddBBBByyyyFFFFoooorrrrmmmmaaaattttNNNNaaaammmmeeee("TIFF") is used by default.
  167.  
  168.           The alternate forms taking a _d_e_s_c argument, encapsulate the _f_d,
  169.           _f_i_l_e_n_a_m_e and _f_o_r_m_a_t arguments in this single argument.  See
  170.           iflFileDesc(3) for more details.
  171.  
  172.           When creating a new image file, the dimensions, data type, dimension
  173.           order, color model, orientation, compression, and page dimensions
  174.           may be specified using the _c_f_g parameter; if not, they are copied
  175.           from the _s_o_u_r_c_e image if one was given (as described below) or
  176.           defaulted to the format's "preferred" value for the respective
  177.           parameter.
  178.  
  179.           When an existing _s_o_u_r_c_e image is specified; any parameters not
  180.           specified in the _c_f_g parameter will be copied from this source image
  181.           (if the value is supported by the destination format) or
  182.           heuristically selected to be a supported value most suitable for
  183.           copying data from the source image.
  184.  
  185.           If there is an error on the open or create operation an error will
  186.           be thrown with iiiillllEEEErrrrrrrroooorrrr() and the objects status will be set to an
  187.           appropriate value (which can be obtained using the ggggeeeettttSSSSttttaaaattttuuuussss()
  188.           method).
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. iiiillllFFFFiiiilllleeeeIIIImmmmgggg((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllFFFFiiiilllleeeeIIIImmmmgggg((((3333))))
  203.  
  204.  
  205.  
  206.      aaaappppppppeeeennnnddddIIIImmmmgggg(((())))
  207.  
  208.           ilStatus appendImg(ilImage* source, iflFileConfig* cfg=NULL)
  209.  
  210.  
  211.           This method appends an image to the image file, and sets the current
  212.           image index to the index of the new (last) image.
  213.  
  214.           The _s_o_u_r_c_e and _c_f_g parameters are treated the same as in the
  215.           versions of the constructor that do image file creation.
  216.  
  217.           On success, the function returns iflOKAY.  If the operation fails
  218.           for some reason, an error will be thrown via the iiiillllEEEErrrrrrrroooorrrr()
  219.           mechanism, and the file's contents and the object's current index
  220.           will be in an unknown state.
  221.  
  222.      cccclllloooosssseeeeFFFFiiiilllleeee(((())))
  223.  
  224.           ilStatus closeFile()
  225.  
  226.  
  227.           This method closes the associated iflFile, if any, and leaves the
  228.           image in an unuseable state until a new file is opened or created
  229.           with the ooooppppeeeennnnFFFFiiiilllleeee() or ccccrrrreeeeaaaatttteeeeFFFFiiiilllleeee() methods.
  230.  
  231.      ccccrrrreeeeaaaatttteeeeFFFFiiiilllleeee(((())))
  232.  
  233.           ilStatus createFile(const char* filename, ilImage* source,
  234.                               iflFileConfig* cfg=NULL, iflFormat* format=NULL)
  235.           ilStatus createFile(int fd, const char* filename, ilImage* source,
  236.                               iflFileConfig* cfg=NULL, iflFormat* format=NULL)
  237.           ilStatus createFile(iflFileDesc& desc, ilImage* source,
  238.                               iflFileConfig* cfg=NULL)
  239.  
  240.  
  241.           These methods are used to create a new image file and associate it
  242.           with this object.
  243.  
  244.           The file is specified via the _f_i_l_e_n_a_m_e and _f_d arguments.  At least
  245.           one of these two arguments must be specified; they are interpreted
  246.           as follows.
  247.  
  248.               if filename != NULL and fd == -1:
  249.                   creates the file with the given filename.
  250.               if filename == NULL and fd != -1:
  251.                   uses the existing open file descriptor.
  252.               if filename != NULL and fd != -1:
  253.                   uses the existing open file descriptor; the filename is
  254.                   stored solely for the ggggeeeettttFFFFiiiilllleeeeNNNNaaaammmmeeee() method and error messages.
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. iiiillllFFFFiiiilllleeeeIIIImmmmgggg((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllFFFFiiiilllleeeeIIIImmmmgggg((((3333))))
  269.  
  270.  
  271.  
  272.           The _f_o_r_m_a_t argument specifies the desired file format.  If _f_o_r_m_a_t is
  273.           NULL, the format is chosen by using the filename's extension.  If no
  274.           match is found, the format iiiiffffllllFFFFoooorrrrmmmmaaaatttt::::::::ffffiiiinnnnddddBBBByyyyFFFFoooorrrrmmmmaaaattttNNNNaaaammmmeeee("TIFF") is
  275.           used by default.
  276.  
  277.           The alternate form taking a _d_e_s_c argument, encapsulates the _f_d,
  278.           _f_i_l_e_n_a_m_e and _f_o_r_m_a_t arguments in this single argument.  See
  279.           iflFileDesc(3) for more details.
  280.  
  281.           The dimensions, data type, dimension order,  color model,
  282.           orientation, compression, and page dimensions may be  specified
  283.           using the _c_f_g parameter; if not, they are copied from  the _s_o_u_r_c_e
  284.           image if one was given (as described below) or  defaulted to the
  285.           format's "preferred" value for the respective  parameter.
  286.  
  287.           When an existing _s_o_u_r_c_e image is specified; any parameters not
  288.           specified in the _c_f_g parameter will be copied from this source image
  289.           (if the value is supported by the destination format) or
  290.           heuristically selected to be a supported value most suitable for
  291.           copying data from the source image.
  292.  
  293.           If there is an error on the create operation an error status will be
  294.           returned and the object's status will be set to the same value.
  295.  
  296.      ffffrrrreeeeeeeeIIIICCCCCCCCPPPPrrrrooooffffiiiilllleeee(((())))
  297.  
  298.           ilStatus freeICCProfile(void* profile)
  299.  
  300.  
  301.           The member function frees the profile returned by ggggeeeettttIIIICCCCCCCCPPPPrrrrooooffffiiiilllleeee().
  302.  
  303.      ggggeeeettttCCCCuuuurrrrrrrreeeennnnttttIIIImmmmgggg(((())))
  304.  
  305.           int getCurrentImg()
  306.  
  307.  
  308.           This function returns the index of the current image.
  309.  
  310.      ggggeeeettttFFFFiiiilllleeeeDDDDeeeesssscccc(((())))
  311.  
  312.           int getFileDesc()
  313.  
  314.  
  315.           This function returns the file descriptor of the associated file.
  316.  
  317.      ggggeeeettttFFFFiiiilllleeeeHHHHaaaannnnddddlllleeee(((())))
  318.  
  319.           iflFile* getFileHandle()
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334. iiiillllFFFFiiiilllleeeeIIIImmmmgggg((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllFFFFiiiilllleeeeIIIImmmmgggg((((3333))))
  335.  
  336.  
  337.  
  338.           This method provides direct access to the underlying iflFile object.
  339.           Direct access to the iflFile object should be avoided whenever
  340.           possible.  The ggggeeeettttIIIItttteeeemmmm()/sssseeeettttIIIItttteeeemmmm() methods are the preferred
  341.           mechanism for dealing with format specific issues.
  342.  
  343.      ggggeeeettttFFFFiiiilllleeeeMMMMooooddddeeee(((())))
  344.  
  345.           int getFileMode()
  346.  
  347.  
  348.           This function returns the file mode of the associated file. See
  349.           <_s_y_s/_f_c_n_t_l._h>.
  350.  
  351.      ggggeeeettttFFFFiiiilllleeeeNNNNaaaammmmeeee(((())))
  352.  
  353.           const char* getFileName()
  354.  
  355.  
  356.           This function returns the name of the associated file.
  357.  
  358.      ggggeeeettttIIIICCCCCCCCPPPPrrrrooooffffiiiilllleeee(((())))
  359.  
  360.           ilStatus getICCProfile(int& size, void*& profile)
  361.  
  362.  
  363.           This virtual member function returns the value of the ICC profile
  364.           associated with the image.  The return value is iflOKAY on success,
  365.           or an appropriate iflStatus error value on failure.  See iflFile(3)
  366.           for more details on ICC profiles.
  367.  
  368.      ggggeeeettttIIIImmmmaaaaggggeeeeFFFFoooorrrrmmmmaaaatttt(((())))
  369.  
  370.           iflFormat* getImageFormat()
  371.  
  372.  
  373.           This function returns the format (as an iflFormat) of the associated
  374.           file.  The list of possible values depends on the currenly installed
  375.           file formats.  You can use iiiiffffllllFFFFoooorrrrmmmmaaaatttt::::::::nnnneeeexxxxtttt() to interate through the
  376.           list of possible file formats.
  377.  
  378.      ggggeeeettttIIIImmmmaaaaggggeeeeFFFFoooorrrrmmmmaaaattttNNNNaaaammmmeeee(((())))
  379.  
  380.           const char* getImageFormatName()
  381.  
  382.  
  383.           This function returns name the format of the associated file.
  384.  
  385.      ggggeeeettttIIIItttteeeemmmm(((())))
  386.  
  387.           ilStatus getItem(int tag, ...)
  388.           ilStatus getItem(int tag, va_list ap)
  389.  
  390.  
  391.  
  392.  
  393.                                                                         PPPPaaaaggggeeee 6666
  394.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400. iiiillllFFFFiiiilllleeeeIIIImmmmgggg((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllFFFFiiiilllleeeeIIIImmmmgggg((((3333))))
  401.  
  402.  
  403.  
  404.           This method gets the value of an item associated with the current
  405.           image in the image file.
  406.  
  407.           The _t_a_g argument specifies the name of the item to be accessed; it
  408.           is interpreted by the specific iflFile subclass. The number and
  409.           types of the remaining arguments are determined the particular
  410.           subclass of iflFile and the tag value.
  411.  
  412.           The return value is iflOKAY on success, or an appropriate iflStatus
  413.           error value on failure.
  414.  
  415.           The second overloaded form of this method is used by libraries that
  416.           are passing along a variable calling sequence in _a_p through some
  417.           wrapper layer.
  418.  
  419.      ggggeeeettttNNNNuuuummmmIIIImmmmggggssss(((())))
  420.  
  421.           int getNumImgs()
  422.  
  423.  
  424.           This function returns the number of images in the associated file.
  425.  
  426.      ooooppppeeeennnnFFFFiiiilllleeee(((())))
  427.  
  428.           ilStatus openFile(const char* filename, int mode=O_RDONLY,
  429.                             iflFormat* format=NULL)
  430.           ilStatus openFile(iflFileDesc& desc, int mode=O_RDONLY)
  431.           ilStatus openFile(int fd, const char* filename, int mode=O_RDONLY,
  432.                             iflFormat* format=NULL)
  433.  
  434.  
  435.           These methods are used to open an existing image file and associate
  436.           it with this object.
  437.  
  438.           The file is specified via the _f_i_l_e_n_a_m_e and _f_d arguments.  At least
  439.           one of these two arguments must be specified; they are interpreted
  440.           as follows.
  441.  
  442.               if filename != NULL and fd == -1:
  443.                   opens the file with the given filename.
  444.               if filename == NULL and fd != -1:
  445.                   uses the existing open file descriptor.
  446.               if filename != NULL and fd != -1:
  447.                   uses the existing open file descriptor; the filename is
  448.                   stored solely for the ggggeeeettttFFFFiiiilllleeeeNNNNaaaammmmeeee() method and error messages.
  449.  
  450.           The file name may be followed by an optional sub-image index using
  451.           the syntax "filename:index" (see sssseeeettttCCCCuuuurrrrrrrreeeennnnttttIIIImmmmaaaaggggeeee() for how to change
  452.           the sub-image index after the file is opened).
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.                                                                         PPPPaaaaggggeeee 7777
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466. iiiillllFFFFiiiilllleeeeIIIImmmmgggg((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllFFFFiiiilllleeeeIIIImmmmgggg((((3333))))
  467.  
  468.  
  469.  
  470.           The mode argument specifies the desired access mode; it should be
  471.           either _O__R_D_O_N_L_Y or _O__R_D_W_R.
  472.  
  473.           The _f_o_r_m_a_t argument specifies the desired file format.  The usual
  474.           usage is to use NULL in which case the file format is deduced by the
  475.           file typing rules using the file's contents ("magic number"); this
  476.           mechanism can be bypassed by specifying the format explicitly.
  477.  
  478.           The alternate form taking a _d_e_s_c argument, encapsulates the _f_d,
  479.           _f_i_l_e_n_a_m_e and _f_o_r_m_a_t arguments in this single argument.  See
  480.           iflFileDesc(3) for more details.
  481.  
  482.           If there is an error on the open operation an error status will be
  483.           returned and the object's status will be set to the same value.
  484.  
  485.      sssseeeettttCCCCuuuurrrrrrrreeeennnnttttIIIImmmmgggg(((())))
  486.  
  487.           ilStatus setCurrentImg(int idx)
  488.  
  489.  
  490.           This function sets the index of the current image to _i_d_x.  If
  491.           successful, this function returns ilOKAY; otherwise (if _i_d_x is not a
  492.           valid image index) ilOUTOFBOUND is returned and the image index is
  493.           not changed.  This function also sets the altered flag.
  494.  
  495.      sssseeeettttIIIICCCCCCCCPPPPrrrrooooffffiiiilllleeee(((())))
  496.  
  497.           ilStatus setICCProfile(int size, const void* profile)
  498.  
  499.  
  500.           This member function sets the value of the ICC profile associated
  501.           with the image.  The return value is ilOKAY on success, or an
  502.           appropriate ilStatus error value on failure.  See iflFile(3) for
  503.           more details on ICC profiles.
  504.  
  505.      sssseeeettttIIIItttteeeemmmm(((())))
  506.  
  507.           ilStatus setItem(int tag, ...)
  508.           ilStatus setItem(int tag, va_list ap)
  509.  
  510.  
  511.           This method sets the value of an item associated with the current
  512.           image in the image file.
  513.  
  514.           Calling sssseeeettttIIIItttteeeemmmm() may change some image attributes. If this occurs
  515.           the cache for the image will be automatically invalidated.
  516.  
  517.           The _t_a_g argument specifies the name of the item to be set; it is
  518.           interpreted by the specific iflFile subclass.  The number and types
  519.           of the remaining arguments are determined the particular subclass of
  520.           iflFile and the tag value.
  521.  
  522.  
  523.  
  524.  
  525.                                                                         PPPPaaaaggggeeee 8888
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532. iiiillllFFFFiiiilllleeeeIIIImmmmgggg((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllFFFFiiiilllleeeeIIIImmmmgggg((((3333))))
  533.  
  534.  
  535.  
  536.           The return value is iflOKAY on success, or an appropriate iflStatus
  537.           error value on failure.
  538.  
  539.           The second overloaded form of this method is used by libraries that
  540.           are passing along a variable calling sequence in _a_p through some
  541.           wrapper layer.
  542.  
  543. IIIINNNNHHHHEEEERRRRIIIITTTTEEEEDDDD MMMMEEEEMMMMBBBBEEEERRRR FFFFUUUUNNNNCCCCTTTTIIIIOOOONNNNSSSS
  544.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllMMMMeeeemmmmCCCCaaaacccchhhheeeeIIIImmmmgggg
  545.      allocPage(), doUserPageAlloc(), enableMP(), executeRequest(),
  546.      finishRequest(), freePage(), getGlobalThrashMode(), getMpRequest(),
  547.      getPage(), getPageAllocTime(), getPageTime(), getRetainMode(),
  548.      getRetainPath(), getThrashMode(), getThrashTime(), getTotalPageTime(),
  549.      isMPenabled(), isUserPageAlloc(), prepareRequest(),
  550.      setGlobalThrashMode(), setPage(), setPageAllocTime(), setRetainMode(),
  551.      setRetainPath(), setThrashMode(),
  552.  
  553.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllCCCCaaaacccchhhheeeeIIIImmmmgggg
  554.      enablePagingCallback(), flush(), getCacheSize(),
  555.      isPagingCallbackEnabled(), listResident()
  556.  
  557.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllIIIImmmmaaaaggggeeee
  558.      addInput(), allocFillData(), checkColorModel(), checkValidOrder(),
  559.      checkValidType(), clipTile(), configureRetainedCache(), copy(),
  560.      copyTile(), copyTile3D(), copyTileCfg(), fillTile(), fillTile3D(),
  561.      fillTileRGB(), freeFillData(), getColorImg(), getColorModel(),
  562.      getColormap(), getCompression(), getConfig(), getCopyConverter(),
  563.      getCsize(), getDataType(), getDimensions(), getDirectInput(),
  564.      getDisplayCacheEnable(), getFill(), getFillData(), getFillValue(),
  565.      getHeight(), getHwEnable(), getHwHint(), getHwIntHint(), getHwOp(),
  566.      getHwPassTable(), getInput(), getInputTileRequirement(),
  567.      getLockTileSet(), getMaxColormapLevels(), getMaxValue(), getMinValue(),
  568.      getNumChans(), getNumInputs(), getOrder(), getOrientation(),
  569.      getPageBorder(), getPageBorderX(), getPageBorderY(), getPageBorderZ(),
  570.      getPageCounts(), getPageDelta(), getPageDimensions(), getPageIndices(),
  571.      getPageOrigin(), getPageOriginC(), getPageOriginX(), getPageOriginY(),
  572.      getPageOriginZ(), getPageSize(), getPageSizeC(), getPageSizePix(),
  573.      getPageSizeVal(), getPageSizeX(), getPageSizeY(), getPageSizeZ(),
  574.      getPixel(), getPixel3D(), getPriority(), getScaleMax(), getScaleMin(),
  575.      getSize(), getStrides(), getSubTile(), getSubTile3D(), getTile(),
  576.      getTile3D(), getWidth(), getXsize(), getYsize(), getZsize(),
  577.      hasPageBorder(), hasPages(), hwDefine(), hwGetPass(), inherit(),
  578.      initColorModel(), initHwEnable(), initMinMax(), initPageSize(),
  579.      initScaleMinMax(), isColorImg(), isIntegral(), isMirrorOrientation(),
  580.      isPartialPage(), isSigned(), isValidPage(), isWritable(), lockPage(),
  581.      lockPageSet(), lockTile(), lockTile3D(), mapFlipTrans(), mapFromInput(),
  582.      mapFromSource(), mapOrientation(), mapSize(), mapTile(), mapToInput(),
  583.      mapToSource(), mapXY(), mapXYSign(), outOfBound(), qCopyTileCfg(),
  584.      qFillTile3D(), qFillTileRGB(), qGetSubTile3D(), qGetTile3D(),
  585.      qLockPageSet(), qSetSubTile3D(), qSetTile3D(), removeHwHint(),
  586.      removeInput(), reset(), setColorModel(), setColormap(), setCompression(),
  587.      setCsize(), setDataType(), setDisplayCacheEnable(), setFill(),
  588.  
  589.  
  590.  
  591.                                                                         PPPPaaaaggggeeee 9999
  592.  
  593.  
  594.  
  595.  
  596.  
  597.  
  598. iiiillllFFFFiiiilllleeeeIIIImmmmgggg((((3333))))       IIIImmmmaaaaggggeeeeVVVViiiissssiiiioooonnnn LLLLiiiibbbbrrrraaaarrrryyyy CCCC++++++++ RRRReeeeffffeeeerrrreeeennnncccceeee MMMMaaaannnnuuuuaaaallll       iiiillllFFFFiiiilllleeeeIIIImmmmgggg((((3333))))
  599.  
  600.  
  601.  
  602.      setFillValue(), setHwEnable(), setHwHint(), setHwIntHint(), setInput(),
  603.      setMaxColormapLevels(), setMaxValue(), setMinValue(), setNumChans(),
  604.      setNumInputs(), setOrder(), setOrientation(), setPageBorder(),
  605.      setPageSize(), setPageSizeC(), setPageSizeZ(), setPixel(), setPixel3D(),
  606.      setPriority(), setScaleMinMax(), setScaleType(), setSize(), setSubTile(),
  607.      setSubTile3D(), setTile(), setTile3D(), setTileRequirementFunction(),
  608.      setWritable(), setXsize(), setYsize(), setZsize(), unlockPage(),
  609.      unlockPageSet()
  610.  
  611.    IIIInnnnhhhheeeerrrriiiitttteeeedddd ffffrrrroooommmm iiiillllLLLLiiiinnnnkkkk
  612.      addResetCallback(), alterAction(), anyAltered(), clearAllowed(),
  613.      clearSet(), clearStatus(), deleteRelated(), disableAltered(),
  614.      dumpChain(), getClassPropSet(), getDescription(), getDirectParent(),
  615.      getDisabledIndex(), getFloatProp(), getGenerationID(), getIntProp(),
  616.      getMaxIndex(), getMinIndex(), getNumChildren(), getNumParents(),
  617.      getParent(), getProp(), getProp(), getPropSet(), getPtrProp(),
  618.      getRelatedChild(), getRelatedDelete(), getRelatedType(), getStatus(),
  619.      hasResetCallbacks(), ilGetClassPropSet(), inProgress(), isAllowed(),
  620.      isAltered(), isEnabled(), isRelated(), isSet(), markSet(), mpUnlock(),
  621.      neverReset(), newRelatedType(), removeParent(), removeProp(),
  622.      removeResetCallback(), reset(), resetAltered(), resetCheck(),
  623.      setAllowed(), setAltered(), setDescription(), setDisabledIndex(),
  624.      setEnabled(), setParent(), setProp(), setPropAltered(),
  625.      setRelatedDelete(), setRelatedType(), setStatus(), stopWatching(),
  626.      unalterable(), watch(), watchNotify()
  627.  
  628.  
  629. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  630.      ilMemCacheImg, ilCacheImg, ilImage, ilLink, iflFile, iflFormat,
  631.      iflFileConfig, iflFileDesc
  632.  
  633.  
  634.  
  635.  
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.                                                                        PPPPaaaaggggeeee 11110000
  658.  
  659.  
  660.  
  661.